<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glPushDebugGroup - OpenGL ES 3.2 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glPushDebugGroup">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glPushDebugGroup — push a named debug group into the command stream</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glPushDebugGroup</strong>(</code>
              </td>
              <td>GLenum <var class="pdparam">source</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLuint <var class="pdparam">id</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei <var class="pdparam">length</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>const char * <var class="pdparam">message</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>source</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The source of the debug message.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>id</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The identifier of the message.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>length</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The length of the message to be sent to the debug output stream.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>message</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The a string containing the message to be sent to the debug output stream.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glPushDebugGroup</code> pushes a debug group described by the string
            <em class="parameter"><code>message</code></em> into the command stream. The value of
            <em class="parameter"><code>id</code></em> specifies the ID of messages generated. The parameter
            <em class="parameter"><code>length</code></em> contains the number of characters in <em class="parameter"><code>message</code></em>.
            If <em class="parameter"><code>length</code></em> is negative, it is implied that <em class="parameter"><code>message</code></em>
            contains a null terminated string. The message has the specified <em class="parameter"><code>source</code></em>
            and <em class="parameter"><code>id</code></em>, the <em class="parameter"><code>type</code></em> <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>, and <em class="parameter"><code>severity</code></em>
            <code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code>. The GL will put a new debug group
            on top of the debug group stack which inherits the control of the
            volume of debug output of the debug group previously residing on the
            top of the debug group stack. Because debug groups are strictly
            hierarchical, any additional control of the debug output volume will
            only apply within the active debug group and the debug groups pushed
            on top of the active debug group.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_ENUM</code> is generated if the value of <em class="parameter"><code>source</code></em> is
            neither <code class="constant">GL_DEBUG_SOURCE_APPLICATION</code> nor <code class="constant">GL_DEBUG_SOURCE_THIRD_PARTY</code>.
        </p>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>length</code></em> is negative
            and the number of characters in <em class="parameter"><code>message</code></em>, excluding the null-terminator,
            is not less than the value of <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>.
        </p>
      </div>
      <div class="refsect1" id="associatedgets">
        <h2>Associated Gets</h2>
        <p>
            <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>.
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="4">
                <span class="bold"><strong>OpenGL ES API Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.1</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.2</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">
                  <code class="function">glPushDebugGroup</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glPopDebugGroup.xhtml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
            <a class="citerefentry" href="glObjectLabel.xhtml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
            <a class="citerefentry" href="glObjectPtrLabel.xhtml"><span class="citerefentry"><span class="refentrytitle">glObjectPtrLabel</span></span></a>.
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2013-2015 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
